<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>Handler (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
  </script>

  <script src="static/js/doc.js">
  </script>

  <meta charset="utf8">
</head>

<body onload="prettyPrint()">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
        <span class="fn">net.BrowserChannel.Handler</span>
        <span>Extends</span>
        <span class="fn-name">
          <a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">
            Object</a>
        </span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Interface for the browser channel handler
  </div>


        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="closure_goog_net_browserchannel.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
          </ol>
        </div>
</div>






<h2 class="g-first">Inheritance</h2>
<pre class="inheritance">
Object
     <img src="static/images/inherit.gif">goog.net.BrowserChannel.Handler
</pre>




  <h2>Constructor</h2>
      <div class="fn-constructor">
    goog.net.BrowserChannel.Handler(<span></span>)
  </div>



<h2>Instance Methods</h2>


  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_net_BrowserChannel_Handler.html">
              goog.net.BrowserChannel.Handler
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.channelClosed"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">channelClosed<span class="args">(<span class="arg">browserChannel</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Indicates the BrowserChannel is closed.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1612">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.channelError"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">channelError<span class="args">(<span class="arg">browserChannel</span>,&nbsp;<span class="arg">error</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Indicates an error occurred on the BrowserChannel.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">error</span>
        : <div class="fullType"><span class="type">goog.net.BrowserChannel.Error</span></div>
        <div class="entryOverview">The error code.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1603">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.channelHandleArray"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">channelHandleArray<span class="args">(<span class="arg">browserChannel</span>,&nbsp;<span class="arg">array</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       New input is available for the application to process.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">array</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span></div>
        <div class="entryOverview">The data array.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1591">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.channelHandleMultipleArrays"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">channelHandleMultipleArrays<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Callback handler for when a batch of response arrays is received from the
server.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1557">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.channelOpened"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">channelOpened<span class="args">(<span class="arg">browserChannel</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Indicates the BrowserChannel has successfully negotiated with the server
and can now send and receive data.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1580">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.getAdditionalParams"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getAdditionalParams<span class="args">(<span class="arg">browserChannel</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>
      </div>


     <div class="entryOverview">
       Gets any parameters that should be added at the time another connection is
made to the server.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>&nbsp;
            Extra parameter keys and values to add to the requests.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1624">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.getNetworkTestImageUri"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getNetworkTestImageUri<span class="args">(<span class="arg">browserChannel</span>)</span>
        </span>
        &#8658; <div class="fullType"><span>?</span><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>
      </div>


     <div class="entryOverview">
       Gets the URI of an image that can be used to test network connectivity.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span>?</span><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>&nbsp;
            A custom URI to load for the network test.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1635">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.isActive"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isActive<span class="args">(<span class="arg">browserChannel</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Gets whether this channel is currently active. This is used to determine the
length of time to wait before retrying.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            Whether the channel is currently active.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1647">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.Handler.prototype.okToMakeRequest"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">okToMakeRequest<span class="args">(<span class="arg">browserChannel</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type">goog.net.BrowserChannel.Error</span></div>
      </div>


     <div class="entryOverview">
       Whether it&#39;s okay to make a request to the server. A handler can return
false if the channel should fail. For example, if the user has logged out,
the handler may want all requests to fail immediately.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">browserChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel.html">goog.net.BrowserChannel</a></span></div>
        <div class="entryOverview">The browser channel.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type">goog.net.BrowserChannel.Error</span></div>&nbsp;
            An error code. The code should return goog.net.BrowserChannel.Error.OK to indicate it&#39;s okay. Any other error code will cause a failure.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1569">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




















<div class="section">
  <table class="horiz-rule">


  </table>
</div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package net</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="goog" current="net.BrowserChannel.Handler"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
